Skip to content

chore: propagate JSDoc callback-type alignment to _tools/markdown#11863

Merged
kgryte merged 1 commit intodevelopfrom
philipp/fix-propagation-2026-04-30
May 1, 2026
Merged

chore: propagate JSDoc callback-type alignment to _tools/markdown#11863
kgryte merged 1 commit intodevelopfrom
philipp/fix-propagation-2026-04-30

Conversation

@Planeshifter
Copy link
Copy Markdown
Member

Propagating fixes merged to develop between 2026-04-29 18:17 -0400 and 2026-04-30 11:44 +0530 to sibling packages.

Description

This pull request propagates a single namespace-alignment correction surfaced in the last 24h of develop:

chore: align outliers in _tools/* with namespace majority patterns — propagates a2c531cd9

Aligns _tools/markdown/to-html/lib/main.js with sibling files by changing the clbk JSDoc type annotation from {Function} to {Callback}, consistent with the pattern established across _tools/markdown/inline-svg-equation/lib/main.js and _tools/markdown/namespace-toc/lib/async.js. Propagates the same one-token correction applied to _tools/lint in a2c531cd9. No semantic effect.

Target package:

  • lib/node_modules/@stdlib/_tools/markdown/to-html/lib/main.js

Related Issues

None.

Questions

No.

Other

Validation

  • Pattern search scope: all lib/node_modules/@stdlib/_tools/**/*.js files matching @param {Function} clbk, partitioned by top-level _tools/<sub>/ namespace.
  • Namespace-majority filter: kept only sites where the local namespace (_tools/<sub>/) had a clear {Callback} majority among non-fixture sources. _tools/github (55 {Function} vs 19 {Callback}) and _tools/scripts (2 vs 0) were dropped — {Function} is the local majority there. _tools/docs (4 vs 4) and _tools/utils (1 vs 1) were dropped — no majority.
  • Independent validation: two opus agents reviewed the surviving site in full; both returned confirmed. The clbk parameter is a node-style error-first callback (clbk(error) / clbk(null, html)), no local Callback typedef, not a fixture.
  • Adaptation pass: mechanical — the source patch applies verbatim modulo the description wording (preserved as on completion, the site-local phrasing).
  • Style-consistency pass: sonnet agent confirmed JSDoc spacing, leading * continuation, and description wording match stdlib conventions and sibling files.
  • Deliberately excluded:
    • _tools/eslint/rules/jsdoc-doctest/test/fixtures/valid.js — ESLint rule test fixture; {Function} content is potentially intentional for the rule under test.
    • Bot-generated commits e34b36cde (docs: update namespace table of contents) and 6b16c0bec (docs: update related packages sections) — automation downstream of new-package additions, no underlying defect pattern.
    • b48118129 (docs: add hpsf conference image link) — single-instance content fill; no other empty src="" images exist in docs/.
    • The added namespace-aliases/test/test.js portion of a2c531cd9 — a single, already-resolved missing-test outlier; no other lint package lacks test/test.js.

Checklist

AI Assistance

  • Yes
  • No

If you answered "yes" above, how did you use AI assistance?

  • Code generation (e.g., when writing an implementation or fixing a bug)
  • Test/benchmark generation
  • Documentation (including examples)
  • Research and understanding

Disclosure

This PR was authored by Claude Code as part of an automated fix-propagation routine. The propagation site was identified by a sonnet pattern-specification agent, validated by two independent opus agents plus an opus adaptation agent and a sonnet style-consistency agent, then committed and opened as a draft. A maintainer should audit before promoting out of draft.


@stdlib-js/reviewers


Generated by Claude Code

…rity pattern

Propagates fix from a2c531cd9 ("chore: align outliers in `_tools/lint` with namespace majority patterns") to a sibling outlier in `_tools/markdown`. Aligns the JSDoc type annotation for the `clbk` callback parameter from `{Function}` to `{Callback}`, matching the pattern used by sibling files `_tools/markdown/inline-svg-equation/lib/main.js` and `_tools/markdown/namespace-toc/lib/async.js`.
@stdlib-bot stdlib-bot added the Tools Issue or pull request related to project tooling. label Apr 30, 2026
@Planeshifter Planeshifter marked this pull request as ready for review May 1, 2026 03:51
@Planeshifter Planeshifter requested a review from a team May 1, 2026 03:51
@Planeshifter Planeshifter changed the title chore: propagate _tools/lint JSDoc callback-type alignment to _tools/markdown chore: propagate JSDoc callback-type alignment to _tools/markdown May 1, 2026
@Planeshifter Planeshifter requested review from kgryte May 1, 2026 03:51
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label May 1, 2026
@kgryte kgryte added Documentation Improvements, additions, or changes to documentation. and removed Needs Review A pull request which needs code review. labels May 1, 2026
@kgryte kgryte merged commit 755a2ee into develop May 1, 2026
73 checks passed
@kgryte kgryte deleted the philipp/fix-propagation-2026-04-30 branch May 1, 2026 21:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements, additions, or changes to documentation. Tools Issue or pull request related to project tooling.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants